/*
 * #%L
 * Fork of JAI Image I/O Tools.
 * %%
 * Copyright (C) 2008 - 2015 Open Microscopy Environment:
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 *   - University of Dundee
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

/*
 * $RCSfile: StreamMsgLogger.java,v $
 * $Revision: 1.1 $
 * $Date: 2005/02/11 05:02:26 $
 * $State: Exp $
 *
 * Class:                   StreamMsgLogger
 *
 * Description:             Implementation of MsgLogger for streams
 *
 *
 * COPYRIGHT:
 *
 * This software module was originally developed by Raphaël Grosbois and
 * Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel
 * Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David
 * Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research
 * Centre France S.A) in the course of development of the JPEG2000
 * standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This
 * software module is an implementation of a part of the JPEG 2000
 * Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio
 * Systems AB and Canon Research Centre France S.A (collectively JJ2000
 * Partners) agree not to assert against ISO/IEC and users of the JPEG
 * 2000 Standard (Users) any of their rights under the copyright, not
 * including other intellectual property rights, for this software module
 * with respect to the usage by ISO/IEC and Users of this software module
 * or modifications thereof for use in hardware or software products
 * claiming conformance to the JPEG 2000 Standard. Those intending to use
 * this software module in hardware or software products are advised that
 * their use may infringe existing patents. The original developers of
 * this software module, JJ2000 Partners and ISO/IEC assume no liability
 * for use of this software module or modifications thereof. No license
 * or right to this software module is granted for non JPEG 2000 Standard
 * conforming products. JJ2000 Partners have full right to use this
 * software module for his/her own purpose, assign or donate this
 * software module to any third party and to inhibit third parties from
 * using this software module for non JPEG 2000 Standard conforming
 * products. This copyright notice must be included in all copies or
 * derivative works of this software module.
 *
 * Copyright (c) 1999/2000 JJ2000 Partners.
 *
 */


package jj2000.j2k.util;

import java.io.*;

/**
 * This class implements the MsgLogger interface for streams. Streams can
 * be simple files, terminals, stdout, stderr, etc. The messages or simple
 * strings are formatted using the linewidth given to the constructor.
 *
 * <P>Messages are printed to the 'err' stream if they are of severity WARNING
 * or ERROR, otherwise they are printed to the 'out' stream. Simple strings
 * are always printed the 'out' stream.
 * */
public class StreamMsgLogger implements MsgLogger {

    /** The 'out' stream */
    private PrintWriter out;

    /** The 'err' stream */
    private PrintWriter err;

    /** The printer that formats the text */
    private MsgPrinter mp;

    /**
     * Constructs a StreamMsgLogger that uses 'outstr' as the 'out' stream,
     * and 'errstr' as the 'err' stream. Note that 'outstr' and 'errstr' can
     * be System.out and System.err.
     *
     * @param outstr Where to print simple strings and LOG and INFO messages.
     *
     * @param errstr Where to print WARNING and ERROR messages
     *
     * @param lw The line width to use in formatting
     *
     *
     * */
    public StreamMsgLogger(OutputStream outstr, OutputStream errstr, int lw) {
        out = new PrintWriter(outstr,true);
        err = new PrintWriter(errstr,true);
        mp = new MsgPrinter(lw);
    }

    /**
     * Constructs a StreamMsgLogger that uses 'outstr' as the 'out' stream,
     * and 'errstr' as the 'err' stream. Note that 'outstr' and 'errstr' can
     * be System.out and System.err.
     *
     * @param outstr Where to print simple strings and LOG and INFO messages.
     *
     * @param errstr Where to print WARNING and ERROR messages
     *
     * @param lw The line width to use in formatting
     *
     *
     * */
    public StreamMsgLogger(Writer outstr, Writer errstr, int lw) {
        out = new PrintWriter(outstr,true);
        err = new PrintWriter(errstr,true);
        mp = new MsgPrinter(lw);
    }

    /**
     * Constructs a StreamMsgLogger that uses 'outstr' as the 'out' stream,
     * and 'errstr' as the 'err' stream. Note that 'outstr' and 'errstr' can
     * be System.out and System.err.
     *
     * @param outstr Where to print simple strings and LOG and INFO messages.
     *
     * @param errstr Where to print WARNING and ERROR messages
     *
     * @param lw The line width to use in formatting
     *
     *
     * */
    public StreamMsgLogger(PrintWriter outstr, PrintWriter errstr, int lw) {
        out = outstr;
        err = errstr;
        mp = new MsgPrinter(lw);
    }

    /**
     * Prints the message 'msg' to the output device, appending a newline,
     * with severity 'sev'. The severity of the message is prepended to the
     * message.
     *
     * @param sev The message severity (LOG, INFO, etc.)
     *
     * @param msg The message to display
     *
     *
     * */
    public void printmsg(int sev, String msg) {
        PrintWriter lout;
        int ind;
        String prefix;

        switch (sev) {
        case LOG:
            prefix = "[LOG]: ";
            lout = out;
            break;
        case INFO:
            prefix = "[INFO]: ";
            lout = out;
            break;
        case WARNING:
            prefix = "[WARNING]: ";
            lout = err;
            break;
        case ERROR:
            prefix = "[ERROR]: ";
            lout = err;
            break;
        default:
            throw new IllegalArgumentException("Severity "+sev+" not valid.");
        }

        mp.print(lout,0,prefix.length(),prefix+msg);
        lout.flush();
    }

    /**
     * Prints the string 'str' to the 'out' stream, appending a newline. The
     * message is reformatted to the line width given to the constructors and
     * using 'flind' characters to indent the first line and 'ind' characters
     * to indent the second line. However, any newlines appearing in 'str' are
     * respected. The output device may or may not display the string until
     * flush() is called, depending on the autoflush state of the PrintWriter,
     * to be sure flush() should be called to write the string to the
     * device. This method just prints the string, the string does not make
     * part of a "message" in the sense that noe severity is associated to it.
     *
     * @param str The string to print
     *
     * @param flind Indentation of the first line
     *
     * @param ind Indentation of any other lines.
     *
     *
     * */
    public void println(String str, int flind, int ind) {
        mp.print(out,flind,ind,str);
    }

    /**
     * Writes any buffered data from the print() and println() methods to the
     * device.
     *
     *
     * */
    public void flush() {
        out.flush();
    }

}
